/*
 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.text.spi;

import java.text.NumberFormat;
import java.util.Locale;
import java.util.spi.LocaleServiceProvider;

/**
 * An abstract class for service providers that
 * provide concrete implementations of the
 * {@link java.text.NumberFormat NumberFormat} class.
 *
 * @since 1.6
 */
public abstract class NumberFormatProvider extends LocaleServiceProvider {

  /**
   * Sole constructor.  (For invocation by subclass constructors, typically
   * implicit.)
   */
  protected NumberFormatProvider() {
  }

  /**
   * Returns a new <code>NumberFormat</code> instance which formats
   * monetary values for the specified locale.
   *
   * @param locale the desired locale.
   * @return a currency formatter
   * @throws NullPointerException if <code>locale</code> is null
   * @throws IllegalArgumentException if <code>locale</code> isn't one of the locales returned from
   * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
   * @see java.text.NumberFormat#getCurrencyInstance(java.util.Locale)
   */
  public abstract NumberFormat getCurrencyInstance(Locale locale);

  /**
   * Returns a new <code>NumberFormat</code> instance which formats
   * integer values for the specified locale.
   * The returned number format is configured to
   * round floating point numbers to the nearest integer using
   * half-even rounding (see {@link java.math.RoundingMode#HALF_EVEN HALF_EVEN})
   * for formatting, and to parse only the integer part of
   * an input string (see {@link
   * java.text.NumberFormat#isParseIntegerOnly isParseIntegerOnly}).
   *
   * @param locale the desired locale
   * @return a number format for integer values
   * @throws NullPointerException if <code>locale</code> is null
   * @throws IllegalArgumentException if <code>locale</code> isn't one of the locales returned from
   * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
   * @see java.text.NumberFormat#getIntegerInstance(java.util.Locale)
   */
  public abstract NumberFormat getIntegerInstance(Locale locale);

  /**
   * Returns a new general-purpose <code>NumberFormat</code> instance for
   * the specified locale.
   *
   * @param locale the desired locale
   * @return a general-purpose number formatter
   * @throws NullPointerException if <code>locale</code> is null
   * @throws IllegalArgumentException if <code>locale</code> isn't one of the locales returned from
   * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
   * @see java.text.NumberFormat#getNumberInstance(java.util.Locale)
   */
  public abstract NumberFormat getNumberInstance(Locale locale);

  /**
   * Returns a new <code>NumberFormat</code> instance which formats
   * percentage values for the specified locale.
   *
   * @param locale the desired locale
   * @return a percent formatter
   * @throws NullPointerException if <code>locale</code> is null
   * @throws IllegalArgumentException if <code>locale</code> isn't one of the locales returned from
   * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
   * @see java.text.NumberFormat#getPercentInstance(java.util.Locale)
   */
  public abstract NumberFormat getPercentInstance(Locale locale);
}
